<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration.tree.xpath;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.Collections;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.List;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.StringTokenizer;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.commons.configuration.tree.ConfigurationNode;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.configuration.tree.ExpressionEngine;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.configuration.tree.NodeAddData;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.commons.jxpath.JXPathContext;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.commons.jxpath.ri.JXPathContextReferenceImpl;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>    /**<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * A specialized implementation of the {@code ExpressionEngine} interface<a name="line.32"></a>
<FONT color="green">033</FONT>     * that is able to evaluate XPATH expressions.<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;/p&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * This class makes use of &lt;a href="http://commons.apache.org/jxpath/"&gt; Commons<a name="line.36"></a>
<FONT color="green">037</FONT>     * JXPath&lt;/a&gt; for handling XPath expressions and mapping them to the nodes of a<a name="line.37"></a>
<FONT color="green">038</FONT>     * hierarchical configuration. This makes the rich and powerful XPATH syntax<a name="line.38"></a>
<FONT color="green">039</FONT>     * available for accessing properties from a configuration object.<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;p&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * For selecting properties arbitrary XPATH expressions can be used, which<a name="line.42"></a>
<FONT color="green">043</FONT>     * select single or multiple configuration nodes. The associated<a name="line.43"></a>
<FONT color="green">044</FONT>     * {@code Configuration} instance will directly pass the specified property<a name="line.44"></a>
<FONT color="green">045</FONT>     * keys into this engine. If a key is not syntactically correct, an exception<a name="line.45"></a>
<FONT color="green">046</FONT>     * will be thrown.<a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;/p&gt;<a name="line.47"></a>
<FONT color="green">048</FONT>     * &lt;p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>     * For adding new properties, this expression engine uses a specific syntax: the<a name="line.49"></a>
<FONT color="green">050</FONT>     * &amp;quot;key&amp;quot; of a new property must consist of two parts that are<a name="line.50"></a>
<FONT color="green">051</FONT>     * separated by whitespace:<a name="line.51"></a>
<FONT color="green">052</FONT>     * &lt;ol&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     * &lt;li&gt;An XPATH expression selecting a single node, to which the new element(s)<a name="line.53"></a>
<FONT color="green">054</FONT>     * are to be added. This can be an arbitrary complex expression, but it must<a name="line.54"></a>
<FONT color="green">055</FONT>     * select exactly one node, otherwise an exception will be thrown.&lt;/li&gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;li&gt;The name of the new element(s) to be added below this parent node. Here<a name="line.56"></a>
<FONT color="green">057</FONT>     * either a single node name or a complete path of nodes (separated by the<a name="line.57"></a>
<FONT color="green">058</FONT>     * &amp;quot;/&amp;quot; character or &amp;quot;@&amp;quot; for an attribute) can be specified.&lt;/li&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     * &lt;/ol&gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     * Some examples for valid keys that can be passed into the configuration's<a name="line.60"></a>
<FONT color="green">061</FONT>     * {@code addProperty()} method follow:<a name="line.61"></a>
<FONT color="green">062</FONT>     * &lt;/p&gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     * &lt;p&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>     *<a name="line.64"></a>
<FONT color="green">065</FONT>     * &lt;pre&gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     * &amp;quot;/tables/table[1] type&amp;quot;<a name="line.66"></a>
<FONT color="green">067</FONT>     * &lt;/pre&gt;<a name="line.67"></a>
<FONT color="green">068</FONT>     *<a name="line.68"></a>
<FONT color="green">069</FONT>     * &lt;/p&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     * &lt;p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     * This will add a new {@code type} node as a child of the first<a name="line.71"></a>
<FONT color="green">072</FONT>     * {@code table} element.<a name="line.72"></a>
<FONT color="green">073</FONT>     * &lt;/p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     * &lt;p&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     *<a name="line.75"></a>
<FONT color="green">076</FONT>     * &lt;pre&gt;<a name="line.76"></a>
<FONT color="green">077</FONT>     * &amp;quot;/tables/table[1] @type&amp;quot;<a name="line.77"></a>
<FONT color="green">078</FONT>     * &lt;/pre&gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     *<a name="line.79"></a>
<FONT color="green">080</FONT>     * &lt;/p&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>     * &lt;p&gt;<a name="line.81"></a>
<FONT color="green">082</FONT>     * Similar to the example above, but this time a new attribute named<a name="line.82"></a>
<FONT color="green">083</FONT>     * {@code type} will be added to the first {@code table} element.<a name="line.83"></a>
<FONT color="green">084</FONT>     * &lt;/p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     * &lt;p&gt;<a name="line.85"></a>
<FONT color="green">086</FONT>     *<a name="line.86"></a>
<FONT color="green">087</FONT>     * &lt;pre&gt;<a name="line.87"></a>
<FONT color="green">088</FONT>     * &amp;quot;/tables table/fields/field/name&amp;quot;<a name="line.88"></a>
<FONT color="green">089</FONT>     * &lt;/pre&gt;<a name="line.89"></a>
<FONT color="green">090</FONT>     *<a name="line.90"></a>
<FONT color="green">091</FONT>     * &lt;/p&gt;<a name="line.91"></a>
<FONT color="green">092</FONT>     * &lt;p&gt;<a name="line.92"></a>
<FONT color="green">093</FONT>     * This example shows how a complex path can be added. Parent node is the<a name="line.93"></a>
<FONT color="green">094</FONT>     * {@code tables} element. Here a new branch consisting of the nodes<a name="line.94"></a>
<FONT color="green">095</FONT>     * {@code table}, {@code fields}, {@code field}, and<a name="line.95"></a>
<FONT color="green">096</FONT>     * {@code name} will be added.<a name="line.96"></a>
<FONT color="green">097</FONT>     * &lt;/p&gt;<a name="line.97"></a>
<FONT color="green">098</FONT>     * &lt;p&gt;<a name="line.98"></a>
<FONT color="green">099</FONT>     *<a name="line.99"></a>
<FONT color="green">100</FONT>     * &lt;pre&gt;<a name="line.100"></a>
<FONT color="green">101</FONT>     * &amp;quot;/tables table/fields/field@type&amp;quot;<a name="line.101"></a>
<FONT color="green">102</FONT>     * &lt;/pre&gt;<a name="line.102"></a>
<FONT color="green">103</FONT>     *<a name="line.103"></a>
<FONT color="green">104</FONT>     * &lt;/p&gt;<a name="line.104"></a>
<FONT color="green">105</FONT>     * &lt;p&gt;<a name="line.105"></a>
<FONT color="green">106</FONT>     * This is similar to the last example, but in this case a complex path ending<a name="line.106"></a>
<FONT color="green">107</FONT>     * with an attribute is defined.<a name="line.107"></a>
<FONT color="green">108</FONT>     * &lt;/p&gt;<a name="line.108"></a>
<FONT color="green">109</FONT>     * &lt;p&gt;<a name="line.109"></a>
<FONT color="green">110</FONT>     * &lt;strong&gt;Note:&lt;/strong&gt; This extended syntax for adding properties only works<a name="line.110"></a>
<FONT color="green">111</FONT>     * with the {@code addProperty()} method. {@code setProperty()} does<a name="line.111"></a>
<FONT color="green">112</FONT>     * not support creating new nodes this way.<a name="line.112"></a>
<FONT color="green">113</FONT>     * &lt;/p&gt;<a name="line.113"></a>
<FONT color="green">114</FONT>     * &lt;p&gt;<a name="line.114"></a>
<FONT color="green">115</FONT>     * From version 1.7 on, it is possible to use regular keys in calls to<a name="line.115"></a>
<FONT color="green">116</FONT>     * {@code addProperty()} (i.e. keys that do not have to contain a<a name="line.116"></a>
<FONT color="green">117</FONT>     * whitespace as delimiter). In this case the key is evaluated, and the biggest<a name="line.117"></a>
<FONT color="green">118</FONT>     * part pointing to an existing node is determined. The remaining part is then<a name="line.118"></a>
<FONT color="green">119</FONT>     * added as new path. As an example consider the key<a name="line.119"></a>
<FONT color="green">120</FONT>     *<a name="line.120"></a>
<FONT color="green">121</FONT>     * &lt;pre&gt;<a name="line.121"></a>
<FONT color="green">122</FONT>     * &amp;quot;tables/table[last()]/fields/field/name&amp;quot;<a name="line.122"></a>
<FONT color="green">123</FONT>     * &lt;/pre&gt;<a name="line.123"></a>
<FONT color="green">124</FONT>     *<a name="line.124"></a>
<FONT color="green">125</FONT>     * If the key does not point to an existing node, the engine will check the<a name="line.125"></a>
<FONT color="green">126</FONT>     * paths {@code "tables/table[last()]/fields/field"},<a name="line.126"></a>
<FONT color="green">127</FONT>     * {@code "tables/table[last()]/fields"},<a name="line.127"></a>
<FONT color="green">128</FONT>     * {@code "tables/table[last()]"}, and so on, until a key is<a name="line.128"></a>
<FONT color="green">129</FONT>     * found which points to a node. Let's assume that the last key listed above can<a name="line.129"></a>
<FONT color="green">130</FONT>     * be resolved in this way. Then from this key the following key is derived:<a name="line.130"></a>
<FONT color="green">131</FONT>     * {@code "tables/table[last()] fields/field/name"} by appending<a name="line.131"></a>
<FONT color="green">132</FONT>     * the remaining part after a whitespace. This key can now be processed using<a name="line.132"></a>
<FONT color="green">133</FONT>     * the original algorithm. Keys of this form can also be used with the<a name="line.133"></a>
<FONT color="green">134</FONT>     * {@code setProperty()} method. However, it is still recommended to use<a name="line.134"></a>
<FONT color="green">135</FONT>     * the old format because it makes explicit at which position new nodes should<a name="line.135"></a>
<FONT color="green">136</FONT>     * be added. For keys without a whitespace delimiter there may be ambiguities.<a name="line.136"></a>
<FONT color="green">137</FONT>     * &lt;/p&gt;<a name="line.137"></a>
<FONT color="green">138</FONT>     *<a name="line.138"></a>
<FONT color="green">139</FONT>     * @since 1.3<a name="line.139"></a>
<FONT color="green">140</FONT>     * @author &lt;a<a name="line.140"></a>
<FONT color="green">141</FONT>     *         href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.141"></a>
<FONT color="green">142</FONT>     *         Configuration team&lt;/a&gt;<a name="line.142"></a>
<FONT color="green">143</FONT>     * @version $Id: XPathExpressionEngine.java 1206563 2011-11-26 19:47:26Z oheger $<a name="line.143"></a>
<FONT color="green">144</FONT>     */<a name="line.144"></a>
<FONT color="green">145</FONT>    public class XPathExpressionEngine implements ExpressionEngine<a name="line.145"></a>
<FONT color="green">146</FONT>    {<a name="line.146"></a>
<FONT color="green">147</FONT>        /** Constant for the path delimiter. */<a name="line.147"></a>
<FONT color="green">148</FONT>        static final String PATH_DELIMITER = "/";<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>        /** Constant for the attribute delimiter. */<a name="line.150"></a>
<FONT color="green">151</FONT>        static final String ATTR_DELIMITER = "@";<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>        /** Constant for the delimiters for splitting node paths. */<a name="line.153"></a>
<FONT color="green">154</FONT>        private static final String NODE_PATH_DELIMITERS = PATH_DELIMITER<a name="line.154"></a>
<FONT color="green">155</FONT>                + ATTR_DELIMITER;<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>        /**<a name="line.157"></a>
<FONT color="green">158</FONT>         * Constant for a space which is used as delimiter in keys for adding<a name="line.158"></a>
<FONT color="green">159</FONT>         * properties.<a name="line.159"></a>
<FONT color="green">160</FONT>         */<a name="line.160"></a>
<FONT color="green">161</FONT>        private static final String SPACE = " ";<a name="line.161"></a>
<FONT color="green">162</FONT>    <a name="line.162"></a>
<FONT color="green">163</FONT>        /**<a name="line.163"></a>
<FONT color="green">164</FONT>         * Executes a query. The passed in property key is directly passed to a<a name="line.164"></a>
<FONT color="green">165</FONT>         * JXPath context.<a name="line.165"></a>
<FONT color="green">166</FONT>         *<a name="line.166"></a>
<FONT color="green">167</FONT>         * @param root the configuration root node<a name="line.167"></a>
<FONT color="green">168</FONT>         * @param key the query to be executed<a name="line.168"></a>
<FONT color="green">169</FONT>         * @return a list with the nodes that are selected by the query<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        public List&lt;ConfigurationNode&gt; query(ConfigurationNode root, String key)<a name="line.171"></a>
<FONT color="green">172</FONT>        {<a name="line.172"></a>
<FONT color="green">173</FONT>            if (StringUtils.isEmpty(key))<a name="line.173"></a>
<FONT color="green">174</FONT>            {<a name="line.174"></a>
<FONT color="green">175</FONT>                return Collections.singletonList(root);<a name="line.175"></a>
<FONT color="green">176</FONT>            }<a name="line.176"></a>
<FONT color="green">177</FONT>            else<a name="line.177"></a>
<FONT color="green">178</FONT>            {<a name="line.178"></a>
<FONT color="green">179</FONT>                JXPathContext context = createContext(root, key);<a name="line.179"></a>
<FONT color="green">180</FONT>                // This is safe because our node pointer implementations will return<a name="line.180"></a>
<FONT color="green">181</FONT>                // a list of configuration nodes.<a name="line.181"></a>
<FONT color="green">182</FONT>                @SuppressWarnings("unchecked")<a name="line.182"></a>
<FONT color="green">183</FONT>                List&lt;ConfigurationNode&gt; result = context.selectNodes(key);<a name="line.183"></a>
<FONT color="green">184</FONT>                if (result == null)<a name="line.184"></a>
<FONT color="green">185</FONT>                {<a name="line.185"></a>
<FONT color="green">186</FONT>                    result = Collections.emptyList();<a name="line.186"></a>
<FONT color="green">187</FONT>                }<a name="line.187"></a>
<FONT color="green">188</FONT>                return result;<a name="line.188"></a>
<FONT color="green">189</FONT>            }<a name="line.189"></a>
<FONT color="green">190</FONT>        }<a name="line.190"></a>
<FONT color="green">191</FONT>    <a name="line.191"></a>
<FONT color="green">192</FONT>        /**<a name="line.192"></a>
<FONT color="green">193</FONT>         * Returns a (canonical) key for the given node based on the parent's key.<a name="line.193"></a>
<FONT color="green">194</FONT>         * This implementation will create an XPATH expression that selects the<a name="line.194"></a>
<FONT color="green">195</FONT>         * given node (under the assumption that the passed in parent key is valid).<a name="line.195"></a>
<FONT color="green">196</FONT>         * As the {@code nodeKey()} implementation of<a name="line.196"></a>
<FONT color="green">197</FONT>         * {@link org.apache.commons.configuration.tree.DefaultExpressionEngine DefaultExpressionEngine}<a name="line.197"></a>
<FONT color="green">198</FONT>         * this method will not return indices for nodes. So all child nodes of a<a name="line.198"></a>
<FONT color="green">199</FONT>         * given parent with the same name will have the same key.<a name="line.199"></a>
<FONT color="green">200</FONT>         *<a name="line.200"></a>
<FONT color="green">201</FONT>         * @param node the node for which a key is to be constructed<a name="line.201"></a>
<FONT color="green">202</FONT>         * @param parentKey the key of the parent node<a name="line.202"></a>
<FONT color="green">203</FONT>         * @return the key for the given node<a name="line.203"></a>
<FONT color="green">204</FONT>         */<a name="line.204"></a>
<FONT color="green">205</FONT>        public String nodeKey(ConfigurationNode node, String parentKey)<a name="line.205"></a>
<FONT color="green">206</FONT>        {<a name="line.206"></a>
<FONT color="green">207</FONT>            if (parentKey == null)<a name="line.207"></a>
<FONT color="green">208</FONT>            {<a name="line.208"></a>
<FONT color="green">209</FONT>                // name of the root node<a name="line.209"></a>
<FONT color="green">210</FONT>                return StringUtils.EMPTY;<a name="line.210"></a>
<FONT color="green">211</FONT>            }<a name="line.211"></a>
<FONT color="green">212</FONT>            else if (node.getName() == null)<a name="line.212"></a>
<FONT color="green">213</FONT>            {<a name="line.213"></a>
<FONT color="green">214</FONT>                // paranoia check for undefined node names<a name="line.214"></a>
<FONT color="green">215</FONT>                return parentKey;<a name="line.215"></a>
<FONT color="green">216</FONT>            }<a name="line.216"></a>
<FONT color="green">217</FONT>    <a name="line.217"></a>
<FONT color="green">218</FONT>            else<a name="line.218"></a>
<FONT color="green">219</FONT>            {<a name="line.219"></a>
<FONT color="green">220</FONT>                StringBuilder buf = new StringBuilder(parentKey.length()<a name="line.220"></a>
<FONT color="green">221</FONT>                        + node.getName().length() + PATH_DELIMITER.length());<a name="line.221"></a>
<FONT color="green">222</FONT>                if (parentKey.length() &gt; 0)<a name="line.222"></a>
<FONT color="green">223</FONT>                {<a name="line.223"></a>
<FONT color="green">224</FONT>                    buf.append(parentKey);<a name="line.224"></a>
<FONT color="green">225</FONT>                    buf.append(PATH_DELIMITER);<a name="line.225"></a>
<FONT color="green">226</FONT>                }<a name="line.226"></a>
<FONT color="green">227</FONT>                if (node.isAttribute())<a name="line.227"></a>
<FONT color="green">228</FONT>                {<a name="line.228"></a>
<FONT color="green">229</FONT>                    buf.append(ATTR_DELIMITER);<a name="line.229"></a>
<FONT color="green">230</FONT>                }<a name="line.230"></a>
<FONT color="green">231</FONT>                buf.append(node.getName());<a name="line.231"></a>
<FONT color="green">232</FONT>                return buf.toString();<a name="line.232"></a>
<FONT color="green">233</FONT>            }<a name="line.233"></a>
<FONT color="green">234</FONT>        }<a name="line.234"></a>
<FONT color="green">235</FONT>    <a name="line.235"></a>
<FONT color="green">236</FONT>        /**<a name="line.236"></a>
<FONT color="green">237</FONT>         * Prepares an add operation for a configuration property. The expected<a name="line.237"></a>
<FONT color="green">238</FONT>         * format of the passed in key is explained in the class comment.<a name="line.238"></a>
<FONT color="green">239</FONT>         *<a name="line.239"></a>
<FONT color="green">240</FONT>         * @param root the configuration's root node<a name="line.240"></a>
<FONT color="green">241</FONT>         * @param key the key describing the target of the add operation and the<a name="line.241"></a>
<FONT color="green">242</FONT>         * path of the new node<a name="line.242"></a>
<FONT color="green">243</FONT>         * @return a data object to be evaluated by the calling configuration object<a name="line.243"></a>
<FONT color="green">244</FONT>         */<a name="line.244"></a>
<FONT color="green">245</FONT>        public NodeAddData prepareAdd(ConfigurationNode root, String key)<a name="line.245"></a>
<FONT color="green">246</FONT>        {<a name="line.246"></a>
<FONT color="green">247</FONT>            if (key == null)<a name="line.247"></a>
<FONT color="green">248</FONT>            {<a name="line.248"></a>
<FONT color="green">249</FONT>                throw new IllegalArgumentException(<a name="line.249"></a>
<FONT color="green">250</FONT>                        "prepareAdd: key must not be null!");<a name="line.250"></a>
<FONT color="green">251</FONT>            }<a name="line.251"></a>
<FONT color="green">252</FONT>    <a name="line.252"></a>
<FONT color="green">253</FONT>            String addKey = key;<a name="line.253"></a>
<FONT color="green">254</FONT>            int index = findKeySeparator(addKey);<a name="line.254"></a>
<FONT color="green">255</FONT>            if (index &lt; 0)<a name="line.255"></a>
<FONT color="green">256</FONT>            {<a name="line.256"></a>
<FONT color="green">257</FONT>                addKey = generateKeyForAdd(root, addKey);<a name="line.257"></a>
<FONT color="green">258</FONT>                index = findKeySeparator(addKey);<a name="line.258"></a>
<FONT color="green">259</FONT>            }<a name="line.259"></a>
<FONT color="green">260</FONT>    <a name="line.260"></a>
<FONT color="green">261</FONT>            List&lt;ConfigurationNode&gt; nodes = query(root, addKey.substring(0, index).trim());<a name="line.261"></a>
<FONT color="green">262</FONT>            if (nodes.size() != 1)<a name="line.262"></a>
<FONT color="green">263</FONT>            {<a name="line.263"></a>
<FONT color="green">264</FONT>                throw new IllegalArgumentException(<a name="line.264"></a>
<FONT color="green">265</FONT>                        "prepareAdd: key must select exactly one target node!");<a name="line.265"></a>
<FONT color="green">266</FONT>            }<a name="line.266"></a>
<FONT color="green">267</FONT>    <a name="line.267"></a>
<FONT color="green">268</FONT>            NodeAddData data = new NodeAddData();<a name="line.268"></a>
<FONT color="green">269</FONT>            data.setParent(nodes.get(0));<a name="line.269"></a>
<FONT color="green">270</FONT>            initNodeAddData(data, addKey.substring(index).trim());<a name="line.270"></a>
<FONT color="green">271</FONT>            return data;<a name="line.271"></a>
<FONT color="green">272</FONT>        }<a name="line.272"></a>
<FONT color="green">273</FONT>    <a name="line.273"></a>
<FONT color="green">274</FONT>        /**<a name="line.274"></a>
<FONT color="green">275</FONT>         * Creates the {@code JXPathContext} used for executing a query. This<a name="line.275"></a>
<FONT color="green">276</FONT>         * method will create a new context and ensure that it is correctly<a name="line.276"></a>
<FONT color="green">277</FONT>         * initialized.<a name="line.277"></a>
<FONT color="green">278</FONT>         *<a name="line.278"></a>
<FONT color="green">279</FONT>         * @param root the configuration root node<a name="line.279"></a>
<FONT color="green">280</FONT>         * @param key the key to be queried<a name="line.280"></a>
<FONT color="green">281</FONT>         * @return the new context<a name="line.281"></a>
<FONT color="green">282</FONT>         */<a name="line.282"></a>
<FONT color="green">283</FONT>        protected JXPathContext createContext(ConfigurationNode root, String key)<a name="line.283"></a>
<FONT color="green">284</FONT>        {<a name="line.284"></a>
<FONT color="green">285</FONT>            JXPathContext context = JXPathContext.newContext(root);<a name="line.285"></a>
<FONT color="green">286</FONT>            context.setLenient(true);<a name="line.286"></a>
<FONT color="green">287</FONT>            return context;<a name="line.287"></a>
<FONT color="green">288</FONT>        }<a name="line.288"></a>
<FONT color="green">289</FONT>    <a name="line.289"></a>
<FONT color="green">290</FONT>        /**<a name="line.290"></a>
<FONT color="green">291</FONT>         * Initializes most properties of a {@code NodeAddData} object. This<a name="line.291"></a>
<FONT color="green">292</FONT>         * method is called by {@code prepareAdd()} after the parent node has<a name="line.292"></a>
<FONT color="green">293</FONT>         * been found. Its task is to interpret the passed in path of the new node.<a name="line.293"></a>
<FONT color="green">294</FONT>         *<a name="line.294"></a>
<FONT color="green">295</FONT>         * @param data the data object to initialize<a name="line.295"></a>
<FONT color="green">296</FONT>         * @param path the path of the new node<a name="line.296"></a>
<FONT color="green">297</FONT>         */<a name="line.297"></a>
<FONT color="green">298</FONT>        protected void initNodeAddData(NodeAddData data, String path)<a name="line.298"></a>
<FONT color="green">299</FONT>        {<a name="line.299"></a>
<FONT color="green">300</FONT>            String lastComponent = null;<a name="line.300"></a>
<FONT color="green">301</FONT>            boolean attr = false;<a name="line.301"></a>
<FONT color="green">302</FONT>            boolean first = true;<a name="line.302"></a>
<FONT color="green">303</FONT>    <a name="line.303"></a>
<FONT color="green">304</FONT>            StringTokenizer tok = new StringTokenizer(path, NODE_PATH_DELIMITERS,<a name="line.304"></a>
<FONT color="green">305</FONT>                    true);<a name="line.305"></a>
<FONT color="green">306</FONT>            while (tok.hasMoreTokens())<a name="line.306"></a>
<FONT color="green">307</FONT>            {<a name="line.307"></a>
<FONT color="green">308</FONT>                String token = tok.nextToken();<a name="line.308"></a>
<FONT color="green">309</FONT>                if (PATH_DELIMITER.equals(token))<a name="line.309"></a>
<FONT color="green">310</FONT>                {<a name="line.310"></a>
<FONT color="green">311</FONT>                    if (attr)<a name="line.311"></a>
<FONT color="green">312</FONT>                    {<a name="line.312"></a>
<FONT color="green">313</FONT>                        invalidPath(path, " contains an attribute"<a name="line.313"></a>
<FONT color="green">314</FONT>                                + " delimiter at an unallowed position.");<a name="line.314"></a>
<FONT color="green">315</FONT>                    }<a name="line.315"></a>
<FONT color="green">316</FONT>                    if (lastComponent == null)<a name="line.316"></a>
<FONT color="green">317</FONT>                    {<a name="line.317"></a>
<FONT color="green">318</FONT>                        invalidPath(path,<a name="line.318"></a>
<FONT color="green">319</FONT>                                " contains a '/' at an unallowed position.");<a name="line.319"></a>
<FONT color="green">320</FONT>                    }<a name="line.320"></a>
<FONT color="green">321</FONT>                    data.addPathNode(lastComponent);<a name="line.321"></a>
<FONT color="green">322</FONT>                    lastComponent = null;<a name="line.322"></a>
<FONT color="green">323</FONT>                }<a name="line.323"></a>
<FONT color="green">324</FONT>    <a name="line.324"></a>
<FONT color="green">325</FONT>                else if (ATTR_DELIMITER.equals(token))<a name="line.325"></a>
<FONT color="green">326</FONT>                {<a name="line.326"></a>
<FONT color="green">327</FONT>                    if (attr)<a name="line.327"></a>
<FONT color="green">328</FONT>                    {<a name="line.328"></a>
<FONT color="green">329</FONT>                        invalidPath(path,<a name="line.329"></a>
<FONT color="green">330</FONT>                                " contains multiple attribute delimiters.");<a name="line.330"></a>
<FONT color="green">331</FONT>                    }<a name="line.331"></a>
<FONT color="green">332</FONT>                    if (lastComponent == null &amp;&amp; !first)<a name="line.332"></a>
<FONT color="green">333</FONT>                    {<a name="line.333"></a>
<FONT color="green">334</FONT>                        invalidPath(path,<a name="line.334"></a>
<FONT color="green">335</FONT>                                " contains an attribute delimiter at an unallowed position.");<a name="line.335"></a>
<FONT color="green">336</FONT>                    }<a name="line.336"></a>
<FONT color="green">337</FONT>                    if (lastComponent != null)<a name="line.337"></a>
<FONT color="green">338</FONT>                    {<a name="line.338"></a>
<FONT color="green">339</FONT>                        data.addPathNode(lastComponent);<a name="line.339"></a>
<FONT color="green">340</FONT>                    }<a name="line.340"></a>
<FONT color="green">341</FONT>                    attr = true;<a name="line.341"></a>
<FONT color="green">342</FONT>                    lastComponent = null;<a name="line.342"></a>
<FONT color="green">343</FONT>                }<a name="line.343"></a>
<FONT color="green">344</FONT>    <a name="line.344"></a>
<FONT color="green">345</FONT>                else<a name="line.345"></a>
<FONT color="green">346</FONT>                {<a name="line.346"></a>
<FONT color="green">347</FONT>                    lastComponent = token;<a name="line.347"></a>
<FONT color="green">348</FONT>                }<a name="line.348"></a>
<FONT color="green">349</FONT>                first = false;<a name="line.349"></a>
<FONT color="green">350</FONT>            }<a name="line.350"></a>
<FONT color="green">351</FONT>    <a name="line.351"></a>
<FONT color="green">352</FONT>            if (lastComponent == null)<a name="line.352"></a>
<FONT color="green">353</FONT>            {<a name="line.353"></a>
<FONT color="green">354</FONT>                invalidPath(path, "contains no components.");<a name="line.354"></a>
<FONT color="green">355</FONT>            }<a name="line.355"></a>
<FONT color="green">356</FONT>            data.setNewNodeName(lastComponent);<a name="line.356"></a>
<FONT color="green">357</FONT>            data.setAttribute(attr);<a name="line.357"></a>
<FONT color="green">358</FONT>        }<a name="line.358"></a>
<FONT color="green">359</FONT>    <a name="line.359"></a>
<FONT color="green">360</FONT>        /**<a name="line.360"></a>
<FONT color="green">361</FONT>         * Tries to generate a key for adding a property. This method is called if a<a name="line.361"></a>
<FONT color="green">362</FONT>         * key was used for adding properties which does not contain a space<a name="line.362"></a>
<FONT color="green">363</FONT>         * character. It splits the key at its single components and searches for<a name="line.363"></a>
<FONT color="green">364</FONT>         * the last existing component. Then a key compatible for adding properties<a name="line.364"></a>
<FONT color="green">365</FONT>         * is generated.<a name="line.365"></a>
<FONT color="green">366</FONT>         *<a name="line.366"></a>
<FONT color="green">367</FONT>         * @param root the root node of the configuration<a name="line.367"></a>
<FONT color="green">368</FONT>         * @param key the key in question<a name="line.368"></a>
<FONT color="green">369</FONT>         * @return the key to be used for adding the property<a name="line.369"></a>
<FONT color="green">370</FONT>         */<a name="line.370"></a>
<FONT color="green">371</FONT>        private String generateKeyForAdd(ConfigurationNode root, String key)<a name="line.371"></a>
<FONT color="green">372</FONT>        {<a name="line.372"></a>
<FONT color="green">373</FONT>            int pos = key.lastIndexOf(PATH_DELIMITER, key.length());<a name="line.373"></a>
<FONT color="green">374</FONT>    <a name="line.374"></a>
<FONT color="green">375</FONT>            while (pos &gt;= 0)<a name="line.375"></a>
<FONT color="green">376</FONT>            {<a name="line.376"></a>
<FONT color="green">377</FONT>                String keyExisting = key.substring(0, pos);<a name="line.377"></a>
<FONT color="green">378</FONT>                if (!query(root, keyExisting).isEmpty())<a name="line.378"></a>
<FONT color="green">379</FONT>                {<a name="line.379"></a>
<FONT color="green">380</FONT>                    StringBuilder buf = new StringBuilder(key.length() + 1);<a name="line.380"></a>
<FONT color="green">381</FONT>                    buf.append(keyExisting).append(SPACE);<a name="line.381"></a>
<FONT color="green">382</FONT>                    buf.append(key.substring(pos + 1));<a name="line.382"></a>
<FONT color="green">383</FONT>                    return buf.toString();<a name="line.383"></a>
<FONT color="green">384</FONT>                }<a name="line.384"></a>
<FONT color="green">385</FONT>                pos = key.lastIndexOf(PATH_DELIMITER, pos - 1);<a name="line.385"></a>
<FONT color="green">386</FONT>            }<a name="line.386"></a>
<FONT color="green">387</FONT>    <a name="line.387"></a>
<FONT color="green">388</FONT>            return SPACE + key;<a name="line.388"></a>
<FONT color="green">389</FONT>        }<a name="line.389"></a>
<FONT color="green">390</FONT>    <a name="line.390"></a>
<FONT color="green">391</FONT>        /**<a name="line.391"></a>
<FONT color="green">392</FONT>         * Helper method for throwing an exception about an invalid path.<a name="line.392"></a>
<FONT color="green">393</FONT>         *<a name="line.393"></a>
<FONT color="green">394</FONT>         * @param path the invalid path<a name="line.394"></a>
<FONT color="green">395</FONT>         * @param msg the exception message<a name="line.395"></a>
<FONT color="green">396</FONT>         */<a name="line.396"></a>
<FONT color="green">397</FONT>        private void invalidPath(String path, String msg)<a name="line.397"></a>
<FONT color="green">398</FONT>        {<a name="line.398"></a>
<FONT color="green">399</FONT>            throw new IllegalArgumentException("Invalid node path: \"" + path<a name="line.399"></a>
<FONT color="green">400</FONT>                    + "\" " + msg);<a name="line.400"></a>
<FONT color="green">401</FONT>        }<a name="line.401"></a>
<FONT color="green">402</FONT>    <a name="line.402"></a>
<FONT color="green">403</FONT>        /**<a name="line.403"></a>
<FONT color="green">404</FONT>         * Determines the position of the separator in a key for adding new<a name="line.404"></a>
<FONT color="green">405</FONT>         * properties. If no delimiter is found, result is -1.<a name="line.405"></a>
<FONT color="green">406</FONT>         *<a name="line.406"></a>
<FONT color="green">407</FONT>         * @param key the key<a name="line.407"></a>
<FONT color="green">408</FONT>         * @return the position of the delimiter<a name="line.408"></a>
<FONT color="green">409</FONT>         */<a name="line.409"></a>
<FONT color="green">410</FONT>        private static int findKeySeparator(String key)<a name="line.410"></a>
<FONT color="green">411</FONT>        {<a name="line.411"></a>
<FONT color="green">412</FONT>            int index = key.length() - 1;<a name="line.412"></a>
<FONT color="green">413</FONT>            while (index &gt;= 0 &amp;&amp; !Character.isWhitespace(key.charAt(index)))<a name="line.413"></a>
<FONT color="green">414</FONT>            {<a name="line.414"></a>
<FONT color="green">415</FONT>                index--;<a name="line.415"></a>
<FONT color="green">416</FONT>            }<a name="line.416"></a>
<FONT color="green">417</FONT>            return index;<a name="line.417"></a>
<FONT color="green">418</FONT>        }<a name="line.418"></a>
<FONT color="green">419</FONT>    <a name="line.419"></a>
<FONT color="green">420</FONT>        // static initializer: registers the configuration node pointer factory<a name="line.420"></a>
<FONT color="green">421</FONT>        static<a name="line.421"></a>
<FONT color="green">422</FONT>        {<a name="line.422"></a>
<FONT color="green">423</FONT>            JXPathContextReferenceImpl<a name="line.423"></a>
<FONT color="green">424</FONT>                    .addNodePointerFactory(new ConfigurationNodePointerFactory());<a name="line.424"></a>
<FONT color="green">425</FONT>        }<a name="line.425"></a>
<FONT color="green">426</FONT>    }<a name="line.426"></a>




























































</PRE>
</BODY>
</HTML>
